<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements.  See the NOTICE file distributed with</a>
<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
<span class="sourceLineNo">007</span><a id="line.7"> * the License.  You may obtain a copy of the License at</a>
<span class="sourceLineNo">008</span><a id="line.8"> *</a>
<span class="sourceLineNo">009</span><a id="line.9"> *      http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
<span class="sourceLineNo">016</span><a id="line.16"> */</a>
<span class="sourceLineNo">017</span><a id="line.17"></a>
<span class="sourceLineNo">018</span><a id="line.18">package org.apache.commons.dbutils;</a>
<span class="sourceLineNo">019</span><a id="line.19"></a>
<span class="sourceLineNo">020</span><a id="line.20">import java.sql.CallableStatement;</a>
<span class="sourceLineNo">021</span><a id="line.21">import java.sql.SQLException;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">/**</a>
<span class="sourceLineNo">024</span><a id="line.24"> * Represents an OUT parameter for a stored procedure.  When running a stored</a>
<span class="sourceLineNo">025</span><a id="line.25"> * procedure with {@link QueryRunner}, pass an instance of</a>
<span class="sourceLineNo">026</span><a id="line.26"> * {@code OutParameter} to indicate that the parameter at that index is an</a>
<span class="sourceLineNo">027</span><a id="line.27"> * OUT parameter.  The value of the parameter may be obtained from the</a>
<span class="sourceLineNo">028</span><a id="line.28"> * {@code OutParameter} instance via {@link #getValue() }.</a>
<span class="sourceLineNo">029</span><a id="line.29"> * &lt;p&gt;</a>
<span class="sourceLineNo">030</span><a id="line.30"> * INOUT parameters are also supported by setting the {@code value} of</a>
<span class="sourceLineNo">031</span><a id="line.31"> * the {@code OutParameter} instance before invoking the stored procedure.</a>
<span class="sourceLineNo">032</span><a id="line.32"> *</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @param &lt;T&gt; the class of the parameter; should be compatible via cast with the</a>
<span class="sourceLineNo">034</span><a id="line.34"> * class returned by the {@code CallableStatement.getObject(int)} method.</a>
<span class="sourceLineNo">035</span><a id="line.35"> */</a>
<span class="sourceLineNo">036</span><a id="line.36">public class OutParameter&lt;T&gt; {</a>
<span class="sourceLineNo">037</span><a id="line.37">    private final int sqlType;</a>
<span class="sourceLineNo">038</span><a id="line.38">    private final Class&lt;T&gt; javaType;</a>
<span class="sourceLineNo">039</span><a id="line.39">    private T value = null;</a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41">    /**</a>
<span class="sourceLineNo">042</span><a id="line.42">     * Construct an {@code OutParameter} for the given JDBC SQL type and</a>
<span class="sourceLineNo">043</span><a id="line.43">     * Java type.</a>
<span class="sourceLineNo">044</span><a id="line.44">     * @param sqlType the JDBC SQL type of the parameter as in</a>
<span class="sourceLineNo">045</span><a id="line.45">     * {@code java.sql.Types}.</a>
<span class="sourceLineNo">046</span><a id="line.46">     * @param javaType the Java class of the parameter value, cast compatible</a>
<span class="sourceLineNo">047</span><a id="line.47">     * with the type returned by {@code CallableStatement.getObject(int)}</a>
<span class="sourceLineNo">048</span><a id="line.48">     * for the JDBC type given by {@code sqlType}.</a>
<span class="sourceLineNo">049</span><a id="line.49">     */</a>
<span class="sourceLineNo">050</span><a id="line.50">    public OutParameter(final int sqlType, final Class&lt;T&gt; javaType) {</a>
<span class="sourceLineNo">051</span><a id="line.51">        this.sqlType = sqlType;</a>
<span class="sourceLineNo">052</span><a id="line.52">        this.javaType = javaType;</a>
<span class="sourceLineNo">053</span><a id="line.53">    }</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55">    /**</a>
<span class="sourceLineNo">056</span><a id="line.56">     * Construct an {@code OutParameter} for the given JDBC SQL type and</a>
<span class="sourceLineNo">057</span><a id="line.57">     * Java type and with the given value.  The parameter will be treated as an</a>
<span class="sourceLineNo">058</span><a id="line.58">     * INOUT parameter if the value is null.</a>
<span class="sourceLineNo">059</span><a id="line.59">     * @param sqlType the JDBC SQL type of the parameter as in</a>
<span class="sourceLineNo">060</span><a id="line.60">     * {@code java.sql.Types}.</a>
<span class="sourceLineNo">061</span><a id="line.61">     * @param javaType the Java class of the parameter value, cast compatible</a>
<span class="sourceLineNo">062</span><a id="line.62">     * with the type returned by {@code CallableStatement.getObject(int)}</a>
<span class="sourceLineNo">063</span><a id="line.63">     * for the JDBC type given by {@code sqlType}.</a>
<span class="sourceLineNo">064</span><a id="line.64">     * @param value the IN value of the parameter</a>
<span class="sourceLineNo">065</span><a id="line.65">     */</a>
<span class="sourceLineNo">066</span><a id="line.66">    public OutParameter(final int sqlType, final Class&lt;T&gt; javaType, final T value) {</a>
<span class="sourceLineNo">067</span><a id="line.67">        this.sqlType = sqlType;</a>
<span class="sourceLineNo">068</span><a id="line.68">        this.javaType = javaType;</a>
<span class="sourceLineNo">069</span><a id="line.69">        this.value = value;</a>
<span class="sourceLineNo">070</span><a id="line.70">    }</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72">    /**</a>
<span class="sourceLineNo">073</span><a id="line.73">     * Get the JDBC SQL type for this OUT parameter.</a>
<span class="sourceLineNo">074</span><a id="line.74">     * @return the JDBC SQL type for this OUT parameter.</a>
<span class="sourceLineNo">075</span><a id="line.75">     */</a>
<span class="sourceLineNo">076</span><a id="line.76">    public int getSqlType() {</a>
<span class="sourceLineNo">077</span><a id="line.77">        return sqlType;</a>
<span class="sourceLineNo">078</span><a id="line.78">    }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80">    /**</a>
<span class="sourceLineNo">081</span><a id="line.81">     * Get the Java class for this OUT parameter.</a>
<span class="sourceLineNo">082</span><a id="line.82">     * @return the Java class for this OUT parameter.</a>
<span class="sourceLineNo">083</span><a id="line.83">     */</a>
<span class="sourceLineNo">084</span><a id="line.84">    public Class&lt;T&gt; getJavaType() {</a>
<span class="sourceLineNo">085</span><a id="line.85">        return javaType;</a>
<span class="sourceLineNo">086</span><a id="line.86">    }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88">    /**</a>
<span class="sourceLineNo">089</span><a id="line.89">     * Get the value of the OUT parameter.  After the stored procedure has</a>
<span class="sourceLineNo">090</span><a id="line.90">     * been executed, the value is the value returned via this parameter.</a>
<span class="sourceLineNo">091</span><a id="line.91">     * @return the value of the OUT parameter.</a>
<span class="sourceLineNo">092</span><a id="line.92">     */</a>
<span class="sourceLineNo">093</span><a id="line.93">    public T getValue() {</a>
<span class="sourceLineNo">094</span><a id="line.94">        return value;</a>
<span class="sourceLineNo">095</span><a id="line.95">    }</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97">    /**</a>
<span class="sourceLineNo">098</span><a id="line.98">     * Set the value of the OUT parameter.  If the value is not null when the</a>
<span class="sourceLineNo">099</span><a id="line.99">     * stored procedure is executed, then the parameter will be treated like an</a>
<span class="sourceLineNo">100</span><a id="line.100">     * INOUT parameter.</a>
<span class="sourceLineNo">101</span><a id="line.101">     * @param value the new value for the parameter.</a>
<span class="sourceLineNo">102</span><a id="line.102">     */</a>
<span class="sourceLineNo">103</span><a id="line.103">    public void setValue(final T value) {</a>
<span class="sourceLineNo">104</span><a id="line.104">        this.value = value;</a>
<span class="sourceLineNo">105</span><a id="line.105">    }</a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107">    /**</a>
<span class="sourceLineNo">108</span><a id="line.108">     * Set the value using the return value of the parameter an the given index</a>
<span class="sourceLineNo">109</span><a id="line.109">     * from the given {@code CallableStatement}.</a>
<span class="sourceLineNo">110</span><a id="line.110">     * @param stmt the already executed statement</a>
<span class="sourceLineNo">111</span><a id="line.111">     * @param index the (1-based) index of the parameter</a>
<span class="sourceLineNo">112</span><a id="line.112">     * @throws SQLException when the value could not be retrieved from the</a>
<span class="sourceLineNo">113</span><a id="line.113">     * statement.</a>
<span class="sourceLineNo">114</span><a id="line.114">     */</a>
<span class="sourceLineNo">115</span><a id="line.115">    void setValue(final CallableStatement stmt, final int index) throws SQLException {</a>
<span class="sourceLineNo">116</span><a id="line.116">        final Object object = stmt.getObject(index);</a>
<span class="sourceLineNo">117</span><a id="line.117">        value = javaType.cast(object);</a>
<span class="sourceLineNo">118</span><a id="line.118">    }</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120">    /**</a>
<span class="sourceLineNo">121</span><a id="line.121">     * Set up the given statement by registering an OUT parameter at the given</a>
<span class="sourceLineNo">122</span><a id="line.122">     * index using the {@code sqlType} and {@code value} of this</a>
<span class="sourceLineNo">123</span><a id="line.123">     * {@code OutParameter}.  If the value is not null, the parameter is</a>
<span class="sourceLineNo">124</span><a id="line.124">     * treated like an INOUT parameter and the value is set on the statement.</a>
<span class="sourceLineNo">125</span><a id="line.125">     * @param stmt the statement the parameter should register on.</a>
<span class="sourceLineNo">126</span><a id="line.126">     * @param index the (1-based) index of the parameter.</a>
<span class="sourceLineNo">127</span><a id="line.127">     * @throws SQLException if the parameter could not be registered, or if the</a>
<span class="sourceLineNo">128</span><a id="line.128">     * value of the parameter could not be set.</a>
<span class="sourceLineNo">129</span><a id="line.129">     */</a>
<span class="sourceLineNo">130</span><a id="line.130">    void register(final CallableStatement stmt, final int index) throws SQLException {</a>
<span class="sourceLineNo">131</span><a id="line.131">        stmt.registerOutParameter(index, sqlType);</a>
<span class="sourceLineNo">132</span><a id="line.132">        if (value != null) {</a>
<span class="sourceLineNo">133</span><a id="line.133">            stmt.setObject(index, value);</a>
<span class="sourceLineNo">134</span><a id="line.134">        }</a>
<span class="sourceLineNo">135</span><a id="line.135">    }</a>
<span class="sourceLineNo">136</span><a id="line.136"></a>
<span class="sourceLineNo">137</span><a id="line.137">    @Override</a>
<span class="sourceLineNo">138</span><a id="line.138">    public String toString() {</a>
<span class="sourceLineNo">139</span><a id="line.139">        return "OutParameter{" + "sqlType=" + sqlType + ", javaType="</a>
<span class="sourceLineNo">140</span><a id="line.140">            + javaType + ", value=" + value + '}';</a>
<span class="sourceLineNo">141</span><a id="line.141">    }</a>
<span class="sourceLineNo">142</span><a id="line.142">}</a>




























































</pre>
</div>
</main>
</body>
</html>
